Provide Text for TODOs in Comments #261
Conversation
WalkthroughThe recent updates focus on enhancing documentation across various components of the project. Changes include clarifying comments, updating property descriptions for better understanding, and minor modifications in Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 23
Review Status
Configuration used: CodeRabbit UI
Files selected for processing (54)
- .gitignore (1 hunks)
- Deepgram/Clients/Live/v1/Client.cs (1 hunks)
- Deepgram/Clients/Speak/v1/Client.cs (1 hunks)
- Deepgram/Factory/HttpClientFactory.cs (1 hunks)
- Deepgram/Models/Analyze/v1/AnalyzeSchema.cs (1 hunks)
- Deepgram/Models/Analyze/v1/Average.cs (1 hunks)
- Deepgram/Models/Analyze/v1/IntentsInfo.cs (1 hunks)
- Deepgram/Models/Analyze/v1/Metadata.cs (1 hunks)
- Deepgram/Models/Analyze/v1/Results.cs (2 hunks)
- Deepgram/Models/Analyze/v1/Segment.cs (1 hunks)
- Deepgram/Models/Analyze/v1/SentimentGroup.cs (1 hunks)
- Deepgram/Models/Analyze/v1/SentimentInfo.cs (1 hunks)
- Deepgram/Models/Analyze/v1/SummaryInfo.cs (1 hunks)
- Deepgram/Models/Analyze/v1/Topic.cs (1 hunks)
- Deepgram/Models/Analyze/v1/TopicGroup.cs (1 hunks)
- Deepgram/Models/Analyze/v1/TopicsInfo.cs (1 hunks)
- Deepgram/Models/Live/v1/Average.cs (1 hunks)
- Deepgram/Models/Live/v1/CloseResponse.cs (1 hunks)
- Deepgram/Models/Live/v1/ErrorResponse.cs (1 hunks)
- Deepgram/Models/Live/v1/LiveSchema.cs (1 hunks)
- Deepgram/Models/Live/v1/Metadata.cs (1 hunks)
- Deepgram/Models/Live/v1/MetadataResponse.cs (1 hunks)
- Deepgram/Models/Live/v1/OpenResponse.cs (1 hunks)
- Deepgram/Models/Live/v1/ResultResponse.cs (1 hunks)
- Deepgram/Models/Live/v1/SpeechStartedResponse.cs (1 hunks)
- Deepgram/Models/Live/v1/UnhandledResponse.cs (1 hunks)
- Deepgram/Models/Live/v1/UtteranceEndResponse.cs (1 hunks)
- Deepgram/Models/Manage/v1/Callback.cs (1 hunks)
- Deepgram/Models/Manage/v1/Config.cs (1 hunks)
- Deepgram/Models/Manage/v1/Invite.cs (1 hunks)
- Deepgram/Models/Manage/v1/Key.cs (1 hunks)
- Deepgram/Models/Manage/v1/MembersResponse.cs (1 hunks)
- Deepgram/Models/Manage/v1/Model.cs (1 hunks)
- Deepgram/Models/Manage/v1/Response.cs (1 hunks)
- Deepgram/Models/Manage/v1/Token.cs (1 hunks)
- Deepgram/Models/Manage/v1/TokenDetails.cs (1 hunks)
- Deepgram/Models/Manage/v1/UsageRequest.cs (1 hunks)
- Deepgram/Models/Manage/v1/UsageRequestsResponse.cs (1 hunks)
- Deepgram/Models/Manage/v1/UsageRequestsSchema.cs (1 hunks)
- Deepgram/Models/Manage/v1/UsageSummarySchema.cs (6 hunks)
- Deepgram/Models/OnPrem/v1/CredentialResponse.cs (1 hunks)
- Deepgram/Models/OnPrem/v1/CredentialsResponse.cs (1 hunks)
- Deepgram/Models/OnPrem/v1/DistributionCredentials.cs (1 hunks)
- Deepgram/Models/OnPrem/v1/Member.cs (1 hunks)
- Deepgram/Models/PreRecorded/v1/Average.cs (1 hunks)
- Deepgram/Models/PreRecorded/v1/Channel.cs (1 hunks)
- Deepgram/Models/PreRecorded/v1/IntentsInfo.cs (1 hunks)
- Deepgram/Models/PreRecorded/v1/Metadata.cs (4 hunks)
- Deepgram/Models/PreRecorded/v1/ModelInfo.cs (1 hunks)
- Deepgram/Models/PreRecorded/v1/Paragraph.cs (1 hunks)
- Deepgram/Models/PreRecorded/v1/PrerecordedSchema.cs (8 hunks)
- Deepgram/Models/PreRecorded/v1/Results.cs (2 hunks)
- Deepgram/Models/PreRecorded/v1/Segment.cs (1 hunks)
- Deepgram/Models/PreRecorded/v1/Sentence.cs (1 hunks)
Files not processed due to max files limit (11)
- Deepgram/Models/PreRecorded/v1/SentimentGroup.cs
- Deepgram/Models/PreRecorded/v1/SentimentInfo.cs
- Deepgram/Models/PreRecorded/v1/SummaryInfo.cs
- Deepgram/Models/PreRecorded/v1/Topic.cs
- Deepgram/Models/PreRecorded/v1/TopicGroup.cs
- Deepgram/Models/PreRecorded/v1/TopicsInfo.cs
- Deepgram/Models/PreRecorded/v1/Utterance.cs
- Deepgram/Models/Speak/v1/SpeakSchema.cs
- Deepgram/Models/Speak/v1/SyncResponse.cs
- Deepgram/TodoAndChanges.md
- Deepgram/Utilities/QueryParameterUtil.cs
Files skipped from review due to trivial changes (8)
- .gitignore
- Deepgram/Models/Analyze/v1/Metadata.cs
- Deepgram/Models/Analyze/v1/SentimentGroup.cs
- Deepgram/Models/Analyze/v1/Topic.cs
- Deepgram/Models/Live/v1/OpenResponse.cs
- Deepgram/Models/Live/v1/UnhandledResponse.cs
- Deepgram/Models/Manage/v1/Config.cs
- Deepgram/Models/Manage/v1/UsageRequest.cs
Additional Context Used
GitHub Check Runs (4)
test (8.0.x) success (3)
Deepgram/Factory/HttpClientFactory.cs: [warning] 20-20:
Possible null reference argument for parameter 'name' in 'IHttpClientBuilder HttpClientFactoryServiceCollectionExtensions.AddHttpClient(IServiceCollection services, string name)'.test (7.0.x) success (3)
Deepgram/Factory/HttpClientFactory.cs: [warning] 20-20:
Possible null reference argument for parameter 'name' in 'IHttpClientBuilder HttpClientFactoryServiceCollectionExtensions.AddHttpClient(IServiceCollection services, string name)'.test (6.0.x) success (3)
Deepgram/Factory/HttpClientFactory.cs: [warning] 20-20:
Possible null reference argument for parameter 'name' in 'IHttpClientBuilder HttpClientFactoryServiceCollectionExtensions.AddHttpClient(IServiceCollection services, string name)'.build success (4)
Deepgram/Factory/HttpClientFactory.cs: [warning] 20-20:
Possible null reference argument for parameter 'name' in 'IHttpClientBuilder HttpClientFactoryServiceCollectionExtensions.AddHttpClient(IServiceCollection services, string name)'.
Deepgram/Factory/HttpClientFactory.cs: [warning] 20-20:
Possible null reference argument for parameter 'name' in 'IHttpClientBuilder HttpClientFactoryServiceCollectionExtensions.AddHttpClient(IServiceCollection services, string name)'.
Additional comments not posted (124)
Deepgram/Models/Analyze/v1/TopicGroup.cs (1)
10-10: The updated comment is clear and enhances the documentation.Deepgram/Models/Manage/v1/MembersResponse.cs (1)
10-10: The updated comment is succinct and improves the documentation.Deepgram/Models/Live/v1/CloseResponse.cs (1)
10-10: The updated comment accurately describes the purpose of the class.Deepgram/Models/OnPrem/v1/CredentialsResponse.cs (1)
10-10: The updated comment clearly describes the purpose of the class.Deepgram/Models/Manage/v1/Invite.cs (2)
10-10: The updated comment for the
16-16: The updated comment for theScopeproperty improves the documentation.Deepgram/Models/Live/v1/Average.cs (2)
10-10: The updated comment for theSentimentproperty enhances the documentation.
16-16: The updated comment for theSentimentScoreproperty improves the documentation.Deepgram/Models/Analyze/v1/IntentsInfo.cs (3)
10-10: Consider expanding the comment forInputTokensto explain what constitutes an input token and how it is used within the model.
16-16: The comment forModelUuidis clear but adding an example UUID or specifying the format could enhance understanding.
22-22: ForOutputTokens, similar toInputTokens, providing more context on what an output token represents and its role in the model would be beneficial.Deepgram/Models/PreRecorded/v1/IntentsInfo.cs (3)
10-10: Expand the comment forInputTokensto include examples or a more detailed explanation of their significance in intents.
16-16: ForModelUuid, consider specifying the expected format or providing an example to clarify the comment.
22-22: Enhance theOutputTokenscomment by detailing their role and importance in the context of intents.Deepgram/Models/Analyze/v1/SentimentInfo.cs (3)
10-10: Clarify theInputTokenscomment by explaining their use in sentiment analysis models.
16-16: ForModelUuid, adding an example or specifying the UUID format could improve clarity.
22-22: Similar to previous files, provide more context onOutputTokensand their significance in sentiment analysis.Deepgram/Models/Manage/v1/TokenDetails.cs (4)
10-10: The comment forFeatureis succinct. Consider adding examples of features to enhance understanding.
16-16: ForInput, specify what the input tokens represent and their role in the model.
22-22: Clarify the purpose ofOutputtokens in the model with examples or a detailed explanation.
28-28: The comment forModelis clear. Adding an example of a model name could further improve clarity.Deepgram/Models/Manage/v1/Model.cs (4)
10-10: The comment forNameis straightforward. Including examples of model names could be helpful.
16-16: ForLanguage, specify the expected format or examples of language codes.
22-22: Clarify theVersioncomment by explaining the versioning scheme used for models.
28-28: The comment forModelIdis clear. Adding an example ID or specifying the format could enhance understanding.Deepgram/Models/Live/v1/SpeechStartedResponse.cs (3)
10-10: The comment forTypeis clear. Consider adding a link to the documentation forLiveTypeenum for quick reference.
17-17: ForChannel, specify what channel index information entails and its significance in the context of speech events.
23-23: Clarify theTimestampcomment by specifying the format (e.g., UNIX timestamp) and its role in event tracking.Deepgram/Models/Live/v1/UtteranceEndResponse.cs (3)
10-10: The comment forTypeis clear. Adding a link to theLiveTypeenum documentation could be beneficial.
17-17: ForChannel, providing more details on the channel index information would improve clarity.
23-23: Clarify theLastWordEndcomment by explaining its significance and the format of the timestamp.Deepgram/Models/Manage/v1/Response.cs (3)
16-16: The comment forCodeis succinct. Specifying the range of return codes or linking to documentation could provide more context.
22-22: ForCompleted, clarify whether this property is a boolean or a status string and its implications.
28-28: The comment forTokenDetailsis clear. Including an example of token details or linking to their documentation could enhance understanding.Deepgram/Models/Live/v1/ErrorResponse.cs (1)
28-28: The updated comment for theTypeproperty is clear and aligns with the PR's objective of enhancing documentation.Deepgram/Models/Analyze/v1/Results.cs (3)
10-10: The updated comment for theIntentsproperty, including a reference toIntentGroup, enhances clarity and documentation.
16-16: The updated comment for theSentimentsproperty, including a reference toSentimentGroup, is a good improvement.
28-28: The updated comment for theTopicsproperty, including a reference toTopicGroup, improves the documentation.Deepgram/Models/OnPrem/v1/DistributionCredentials.cs (5)
10-10: The updated comment for theDistributionCredentialsIdproperty is clear and informative.
16-16: The updated comment for theProviderproperty provides clear information about its purpose.
22-22: The updated comment for theCommentproperty is concise and informative.
28-28: The updated comment for theScopesproperty clearly describes its purpose.
34-34: The updated comment for theCreatedproperty provides clear information about its purpose.Deepgram/Models/Manage/v1/Key.cs (3)
22-22: The updated comment for theScopesproperty is clear and informative, enhancing the documentation.
28-28: The updated comment for theCreatedproperty provides clear information about its purpose.
34-34: The updated comment for theTagsproperty is concise and informative, improving the documentation.Deepgram/Models/PreRecorded/v1/Channel.cs (1)
22-22: The updated comment for theLanguageConfidenceproperty clearly describes its purpose, enhancing the documentation.Deepgram/Models/PreRecorded/v1/Sentence.cs (2)
28-28: The updated comment for theSentimentproperty clearly describes its purpose, enhancing the documentation.
34-34: The updated comment for theSentimentScoreproperty provides clear information about its purpose.Deepgram/Models/Live/v1/Metadata.cs (2)
10-10: The updated comment for theRequestIdproperty is clear and specific, enhancing the documentation.
16-16: The updated comment for theModelUUIDproperty provides clear information about its purpose.Deepgram/Models/PreRecorded/v1/Paragraph.cs (2)
34-34: The updated comment for theSentimentproperty clearly describes its purpose, enhancing the documentation.
40-40: The updated comment for theSentimentScoreproperty provides clear information about its purpose.Deepgram/Models/PreRecorded/v1/Results.cs (3)
16-16: Ensure the comment for theIntentsproperty clearly explains the purpose and usage ofIntentGroup.
22-22: Ensure the comment for theSentimentsproperty clearly explains the purpose and usage ofSentimentGroup.
34-34: Ensure the comment for theTopicsproperty clearly explains the purpose and usage ofTopicGroup.Deepgram/Models/Analyze/v1/Segment.cs (7)
10-10: Ensure the comment for theTextproperty accurately describes the content of the transcribed text.
16-16: Clarify in the comment thatStartWordrepresents the timestamp for the start of the segment, not the index of the start word.
22-22: Clarify in the comment thatEndWordrepresents the timestamp for the end of the segment, not the index of the end word.
28-28: Consider adding examples or further explanation to theSentimentproperty comment to illustrate what constitutes positive, negative, and neutral sentiments.
34-34: Explain how theSentimentScoreis calculated or what its range is in the comment.
40-40: Specify in the comment what kind of topics can be expected in theTopicslist.
46-46: Clarify in the comment howIntentsare determined from the text.Deepgram/Models/PreRecorded/v1/Segment.cs (7)
10-10: Ensure the comment for theTextproperty accurately describes the content of the translated text.
16-16: Clarify in the comment thatStartWordrepresents the start time of the segment in seconds, not the index of the start word.
22-22: Clarify in the comment thatEndWordrepresents the end time of the segment in seconds, not the index of the end word.
28-28: Consider adding examples or further explanation to theSentimentproperty comment to illustrate what constitutes positive, negative, and neutral sentiments.
34-34: Explain how theSentimentScoreis calculated or what its range is in the comment.
40-40: Specify in the comment what kind of topics can be expected in theTopicslist.
46-46: Clarify in the comment howIntentsare determined from the text.Deepgram/Models/Manage/v1/UsageRequestsSchema.cs (1)
22-22: The comment for thePageproperty is clear and accurately describes its purpose.Deepgram/Models/Live/v1/ResultResponse.cs (9)
9-9: Ensure the comment for theChannelproperty accurately describes the channel information it contains.
15-15: Clarify in the comment what theChannelIndexrepresents and how it is used.
21-21: Ensure the comment for theDurationproperty clearly explains what duration it represents.
27-27: Clarify in the comment whatIsFinalindicates about the result.
33-33: Ensure the comment for theMetaDataproperty provides enough context about the metadata information it contains.
39-39: Clarify in the comment whatSpeechFinalindicates about the result.
45-45: Ensure the comment for theStartproperty clearly explains what start time it represents.
51-51: Clarify in the comment what theTypeproperty indicates about the result event.
59-59: Consider removing or updating the TODO comment if it is no longer relevant.Deepgram/Models/Live/v1/MetadataResponse.cs (9)
10-10: Ensure the comment for theChannelsproperty accurately describes the channel count it represents.
16-16: Clarify in the comment what theCreatedproperty represents in terms of the created date/time.
22-22: Ensure the comment for theDurationproperty clearly explains the duration of the audio it represents.
28-28: Clarify in the comment whatModelInfocontains about the model information.
34-34: Specify in the comment what kind of models are included in theModelslist and their UUIDs.
40-40: Clarify the purpose and use of theRequestIdproperty in the comment.
46-46: Ensure the comment for theSha256property provides enough context about the Sha256 information it contains.
52-52: Clarify in the comment the conditions under which theTransactionKeyfield is present.
58-58: Ensure the comment for theTypeproperty accurately describes the metadata event type.Deepgram/Models/Analyze/v1/AnalyzeSchema.cs (11)
10-10: Clarify in the comment what theCallBackproperty is used for and under what conditions it should be provided.
16-16: Specify in the comment what methods are supported for theCallbackMethodproperty.
22-22: Ensure the comment for theCustomIntentproperty clearly explains how to define custom intents.
28-28: Clarify the behavior of theCustomIntentModeproperty in the comment, including the difference betweenstrictandextendedmodes.
34-34: Ensure the comment for theCustomTopicproperty clearly explains how to define custom topics.
40-40: Clarify the behavior of theCustomTopicModeproperty in the comment, including the difference betweenstrictandextendedmodes.
46-46: Clarify in the comment howIntentsare recognized throughout the entire input text.
52-52: Specify in the comment that only English language is supported for theLanguageproperty at this time.
58-58: Clarify in the comment howSentimentrecognizes the sentiment of the entire input text and detects shifts in sentiment.
64-64: Ensure the comment for theSummarizeproperty clearly explains what kind of summary is provided for the input text.
70-70: Clarify in the comment howTopicsare detected throughout the entire input text.Deepgram/Models/PreRecorded/v1/Metadata.cs (5)
36-36: Ensure the comment forIntentsInfoaccurately describes its purpose and usage within the context of the application.
48-48: Verify that the comment forModelsprovides sufficient detail about how models are used to process the submitted audio.
60-60: Confirm that theSentimentInfocomment accurately reflects the type of sentiment information provided by this property.
72-72: Ensure theSummaryInfocomment clearly explains what summary information is included and how it can be utilized.
78-78: Check that theTopicsInfocomment provides a comprehensive description of the topics information it holds.Deepgram/Models/Manage/v1/UsageSummarySchema.cs (7)
91-91: Confirm theNumberscomment accurately describes its feature usage within the application.
97-97: Verify that theParagraphscomment provides clear information on how this feature is utilized.
133-133: Ensure theSentimentcomment accurately reflects the use of the Sentiment Feature within the system.
146-146: Check that theSmartFormatcomment clearly explains the feature's purpose and application.
158-158: Confirm theSummarizecomment provides a comprehensive description of the summarization feature's functionality.
170-170: Verify that theTranslatecomment accurately describes how translation is applied to the audio processing.
182-182: Ensure theUttSplitcomment clearly explains the Utterance Split Feature's purpose and usage.Deepgram/Clients/Speak/v1/Client.cs (1)
81-81: Ensure the logging level and message for the unknown metadata key error are appropriate and provide enough context for debugging.Deepgram/Models/PreRecorded/v1/PrerecordedSchema.cs (11)
44-44: Verify that theCustomTopiccomment accurately describes how custom topics can be specified for submitted audio.
50-50: Ensure theCustomTopicModecomment clearly explains the mode options and their effects on topic detection.
70-70: Confirm theDetectTopicscomment provides a comprehensive description of the topic detection functionality.
121-121: Check that theIntentscomment accurately reflects the intent detection feature's purpose and usage.
142-142: Verify that theMeasurementscomment clearly describes how spoken measurements are handled in the transcription.
162-162: Ensure theParagraphscomment accurately describes the paragraph detection feature and its application.
215-215: Confirm theSentimentcomment provides a clear explanation of the sentiment analysis feature.
228-228: Check that theSummarizecomment accurately reflects the summarization feature's functionality and options.
243-243: Verify that theTopicscomment clearly describes the topic detection feature and its benefits.
249-249: Ensure theUttSplitcomment provides a comprehensive explanation of how utterances are split based on time.
255-255: Confirm theUtterancescomment accurately describes the utterance segmentation feature and its application.
There was a problem hiding this comment.
Actionable comments posted: 0
Review Status
Configuration used: CodeRabbit UI
Files selected for processing (57)
- .gitignore (1 hunks)
- Deepgram/Clients/Live/v1/Client.cs (3 hunks)
- Deepgram/Clients/Speak/v1/Client.cs (1 hunks)
- Deepgram/Factory/HttpClientFactory.cs (2 hunks)
- Deepgram/Models/Analyze/v1/AnalyzeSchema.cs (1 hunks)
- Deepgram/Models/Analyze/v1/Average.cs (1 hunks)
- Deepgram/Models/Analyze/v1/IntentsInfo.cs (1 hunks)
- Deepgram/Models/Analyze/v1/Metadata.cs (1 hunks)
- Deepgram/Models/Analyze/v1/Results.cs (2 hunks)
- Deepgram/Models/Analyze/v1/Segment.cs (1 hunks)
- Deepgram/Models/Analyze/v1/SentimentGroup.cs (1 hunks)
- Deepgram/Models/Analyze/v1/SentimentInfo.cs (1 hunks)
- Deepgram/Models/Analyze/v1/SummaryInfo.cs (1 hunks)
- Deepgram/Models/Analyze/v1/Topic.cs (1 hunks)
- Deepgram/Models/Analyze/v1/TopicGroup.cs (1 hunks)
- Deepgram/Models/Analyze/v1/TopicsInfo.cs (1 hunks)
- Deepgram/Models/Live/v1/Average.cs (1 hunks)
- Deepgram/Models/Live/v1/CloseResponse.cs (1 hunks)
- Deepgram/Models/Live/v1/ErrorResponse.cs (1 hunks)
- Deepgram/Models/Live/v1/LiveSchema.cs (1 hunks)
- Deepgram/Models/Live/v1/Metadata.cs (1 hunks)
- Deepgram/Models/Live/v1/MetadataResponse.cs (1 hunks)
- Deepgram/Models/Live/v1/OpenResponse.cs (1 hunks)
- Deepgram/Models/Live/v1/ResultResponse.cs (1 hunks)
- Deepgram/Models/Live/v1/SpeechStartedResponse.cs (1 hunks)
- Deepgram/Models/Live/v1/UnhandledResponse.cs (1 hunks)
- Deepgram/Models/Live/v1/UtteranceEndResponse.cs (1 hunks)
- Deepgram/Models/Manage/v1/Callback.cs (1 hunks)
- Deepgram/Models/Manage/v1/Config.cs (1 hunks)
- Deepgram/Models/Manage/v1/Invite.cs (1 hunks)
- Deepgram/Models/Manage/v1/Key.cs (1 hunks)
- Deepgram/Models/Manage/v1/MembersResponse.cs (1 hunks)
- Deepgram/Models/Manage/v1/Model.cs (1 hunks)
- Deepgram/Models/Manage/v1/Response.cs (1 hunks)
- Deepgram/Models/Manage/v1/Token.cs (1 hunks)
- Deepgram/Models/Manage/v1/TokenDetails.cs (1 hunks)
- Deepgram/Models/Manage/v1/UsageRequest.cs (1 hunks)
- Deepgram/Models/Manage/v1/UsageRequestsResponse.cs (1 hunks)
- Deepgram/Models/Manage/v1/UsageRequestsSchema.cs (1 hunks)
- Deepgram/Models/Manage/v1/UsageSummarySchema.cs (6 hunks)
- Deepgram/Models/OnPrem/v1/CredentialResponse.cs (1 hunks)
- Deepgram/Models/OnPrem/v1/CredentialsResponse.cs (1 hunks)
- Deepgram/Models/OnPrem/v1/DistributionCredentials.cs (1 hunks)
- Deepgram/Models/OnPrem/v1/Member.cs (1 hunks)
- Deepgram/Models/PreRecorded/v1/Average.cs (1 hunks)
- Deepgram/Models/PreRecorded/v1/Channel.cs (1 hunks)
- Deepgram/Models/PreRecorded/v1/IntentsInfo.cs (1 hunks)
- Deepgram/Models/PreRecorded/v1/Metadata.cs (4 hunks)
- Deepgram/Models/PreRecorded/v1/ModelInfo.cs (1 hunks)
- Deepgram/Models/PreRecorded/v1/Paragraph.cs (1 hunks)
- Deepgram/Models/PreRecorded/v1/PrerecordedSchema.cs (8 hunks)
- Deepgram/Models/PreRecorded/v1/Results.cs (2 hunks)
- Deepgram/Models/PreRecorded/v1/Segment.cs (1 hunks)
- Deepgram/Models/PreRecorded/v1/Sentence.cs (1 hunks)
- Deepgram/Models/PreRecorded/v1/SentimentGroup.cs (1 hunks)
- Deepgram/Models/PreRecorded/v1/SentimentInfo.cs (1 hunks)
- Deepgram/Models/PreRecorded/v1/SummaryInfo.cs (1 hunks)
Files not processed due to max files limit (8)
- Deepgram/Models/PreRecorded/v1/Topic.cs
- Deepgram/Models/PreRecorded/v1/TopicGroup.cs
- Deepgram/Models/PreRecorded/v1/TopicsInfo.cs
- Deepgram/Models/PreRecorded/v1/Utterance.cs
- Deepgram/Models/Speak/v1/SpeakSchema.cs
- Deepgram/Models/Speak/v1/SyncResponse.cs
- Deepgram/TodoAndChanges.md
- Deepgram/Utilities/QueryParameterUtil.cs
Files skipped from review as they are similar to previous changes (55)
- .gitignore
- Deepgram/Clients/Live/v1/Client.cs
- Deepgram/Clients/Speak/v1/Client.cs
- Deepgram/Models/Analyze/v1/AnalyzeSchema.cs
- Deepgram/Models/Analyze/v1/Average.cs
- Deepgram/Models/Analyze/v1/IntentsInfo.cs
- Deepgram/Models/Analyze/v1/Metadata.cs
- Deepgram/Models/Analyze/v1/Results.cs
- Deepgram/Models/Analyze/v1/Segment.cs
- Deepgram/Models/Analyze/v1/SentimentGroup.cs
- Deepgram/Models/Analyze/v1/SentimentInfo.cs
- Deepgram/Models/Analyze/v1/SummaryInfo.cs
- Deepgram/Models/Analyze/v1/Topic.cs
- Deepgram/Models/Analyze/v1/TopicGroup.cs
- Deepgram/Models/Analyze/v1/TopicsInfo.cs
- Deepgram/Models/Live/v1/Average.cs
- Deepgram/Models/Live/v1/CloseResponse.cs
- Deepgram/Models/Live/v1/ErrorResponse.cs
- Deepgram/Models/Live/v1/LiveSchema.cs
- Deepgram/Models/Live/v1/Metadata.cs
- Deepgram/Models/Live/v1/MetadataResponse.cs
- Deepgram/Models/Live/v1/OpenResponse.cs
- Deepgram/Models/Live/v1/ResultResponse.cs
- Deepgram/Models/Live/v1/SpeechStartedResponse.cs
- Deepgram/Models/Live/v1/UnhandledResponse.cs
- Deepgram/Models/Live/v1/UtteranceEndResponse.cs
- Deepgram/Models/Manage/v1/Callback.cs
- Deepgram/Models/Manage/v1/Config.cs
- Deepgram/Models/Manage/v1/Invite.cs
- Deepgram/Models/Manage/v1/Key.cs
- Deepgram/Models/Manage/v1/MembersResponse.cs
- Deepgram/Models/Manage/v1/Model.cs
- Deepgram/Models/Manage/v1/Response.cs
- Deepgram/Models/Manage/v1/Token.cs
- Deepgram/Models/Manage/v1/TokenDetails.cs
- Deepgram/Models/Manage/v1/UsageRequest.cs
- Deepgram/Models/Manage/v1/UsageRequestsResponse.cs
- Deepgram/Models/Manage/v1/UsageRequestsSchema.cs
- Deepgram/Models/Manage/v1/UsageSummarySchema.cs
- Deepgram/Models/OnPrem/v1/CredentialResponse.cs
- Deepgram/Models/OnPrem/v1/CredentialsResponse.cs
- Deepgram/Models/OnPrem/v1/DistributionCredentials.cs
- Deepgram/Models/PreRecorded/v1/Average.cs
- Deepgram/Models/PreRecorded/v1/Channel.cs
- Deepgram/Models/PreRecorded/v1/IntentsInfo.cs
- Deepgram/Models/PreRecorded/v1/Metadata.cs
- Deepgram/Models/PreRecorded/v1/ModelInfo.cs
- Deepgram/Models/PreRecorded/v1/Paragraph.cs
- Deepgram/Models/PreRecorded/v1/PrerecordedSchema.cs
- Deepgram/Models/PreRecorded/v1/Results.cs
- Deepgram/Models/PreRecorded/v1/Segment.cs
- Deepgram/Models/PreRecorded/v1/Sentence.cs
- Deepgram/Models/PreRecorded/v1/SentimentGroup.cs
- Deepgram/Models/PreRecorded/v1/SentimentInfo.cs
- Deepgram/Models/PreRecorded/v1/SummaryInfo.cs
Additional Context Used
GitHub Check Runs (4)
test (8.0.x) success (6)
Deepgram/Factory/HttpClientFactory.cs: [warning] 25-25:
Possible null reference argument for parameter 'name' in 'HttpClient IHttpClientFactory.CreateClient(string name)'.
Deepgram/Factory/HttpClientFactory.cs: [warning] 25-25:
Possible null reference argument for parameter 'name' in 'HttpClient IHttpClientFactory.CreateClient(string name)'.
Deepgram/Factory/HttpClientFactory.cs: [warning] 25-25:
Possible null reference argument for parameter 'name' in 'HttpClient IHttpClientFactory.CreateClient(string name)'.
Deepgram/Factory/HttpClientFactory.cs: [warning] 25-25:
Possible null reference argument for parameter 'name' in 'HttpClient IHttpClientFactory.CreateClient(string name)'.build success (10)
Deepgram/Factory/HttpClientFactory.cs: [warning] 25-25:
Possible null reference argument for parameter 'name' in 'HttpClient IHttpClientFactory.CreateClient(string name)'.
Deepgram/Factory/HttpClientFactory.cs: [warning] 25-25:
Possible null reference argument for parameter 'name' in 'HttpClient IHttpClientFactory.CreateClient(string name)'.
Deepgram/Factory/HttpClientFactory.cs: [warning] 25-25:
Possible null reference argument for parameter 'name' in 'HttpClient IHttpClientFactory.CreateClient(string name)'.
Deepgram/Factory/HttpClientFactory.cs: [warning] 25-25:
Possible null reference argument for parameter 'name' in 'HttpClient IHttpClientFactory.CreateClient(string name)'.
Deepgram/Factory/HttpClientFactory.cs: [warning] 25-25:
Possible null reference argument for parameter 'name' in 'HttpClient IHttpClientFactory.CreateClient(string name)'.
Deepgram/Factory/HttpClientFactory.cs: [warning] 25-25:
Possible null reference argument for parameter 'name' in 'HttpClient IHttpClientFactory.CreateClient(string name)'.
Deepgram/Factory/HttpClientFactory.cs: [warning] 25-25:
Possible null reference argument for parameter 'name' in 'HttpClient IHttpClientFactory.CreateClient(string name)'.
Deepgram/Factory/HttpClientFactory.cs: [warning] 25-25:
Possible null reference argument for parameter 'name' in 'HttpClient IHttpClientFactory.CreateClient(string name)'.test (7.0.x) success (6)
Deepgram/Factory/HttpClientFactory.cs: [warning] 25-25:
Possible null reference argument for parameter 'name' in 'HttpClient IHttpClientFactory.CreateClient(string name)'.
Deepgram/Factory/HttpClientFactory.cs: [warning] 25-25:
Possible null reference argument for parameter 'name' in 'HttpClient IHttpClientFactory.CreateClient(string name)'.
Deepgram/Factory/HttpClientFactory.cs: [warning] 25-25:
Possible null reference argument for parameter 'name' in 'HttpClient IHttpClientFactory.CreateClient(string name)'.
Deepgram/Factory/HttpClientFactory.cs: [warning] 25-25:
Possible null reference argument for parameter 'name' in 'HttpClient IHttpClientFactory.CreateClient(string name)'.test (6.0.x) success (6)
Deepgram/Factory/HttpClientFactory.cs: [warning] 25-25:
Possible null reference argument for parameter 'name' in 'HttpClient IHttpClientFactory.CreateClient(string name)'.
Deepgram/Factory/HttpClientFactory.cs: [warning] 25-25:
Possible null reference argument for parameter 'name' in 'HttpClient IHttpClientFactory.CreateClient(string name)'.
Deepgram/Factory/HttpClientFactory.cs: [warning] 25-25:
Possible null reference argument for parameter 'name' in 'HttpClient IHttpClientFactory.CreateClient(string name)'.
Deepgram/Factory/HttpClientFactory.cs: [warning] 25-25:
Possible null reference argument for parameter 'name' in 'HttpClient IHttpClientFactory.CreateClient(string name)'.
Additional comments not posted (3)
Deepgram/Models/OnPrem/v1/Member.cs (2)
10-10: The comment "Member ID" is succinct and generally clear. However, if there's any specific format or constraints associated with theMemberId, consider adding that information for greater clarity.
16-16: The comment "Email of the member" is clear and adequately describes the property.Deepgram/Factory/HttpClientFactory.cs (1)
20-20: The approach of usinghttpId ?? HTTPCLIENT_NAMEeffectively addresses the potential null reference issue when creating an HttpClient. This ensures that a validnameis always passed toIHttpClientFactory.CreateClient.
Addresses issue: #210
This PR just fills in
TODOplaceholders for comments. There should be zero code changes in here (that I can recall).Summary by CodeRabbit
Summary by CodeRabbit